LotusScript Doc

Class: LSAWebPageS

Maintaines a list of LSAWebPageItems.

Version:
1.2.4, 23.NOV.2000 <BR>
History:
23.NOV.2000RGRbug in Get WebPageDefaultS
27.JUL.2000RGRproperty DefaultWebPage changed
08.JUN.2000RGRDelete method changed



Property Summary
Public Property Get Count As Integer
Public Property Get DefaultWebPage As String
Public Property Set ItemDelimiter As String
Public Property Get ItemDelimiter As String
Public Property Set ListDelimiter As String
Public Property Get ListDelimiter As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant
Public Property Get WebPageDefaultS As Variant
Public Property Get WebPageKeyS As Variant
Public Property Get WebPageList As Variant
Public Property Get WebPageS As Variant

Method Summary
Sub AddItem (NewItem As LSAWebPageItem)
Sub ClearAllItems ()
Sub ClearCurrentItem ()
Sub Delete ()
Sub Explode (SerialDataArr As Variant)
Function GetCurrentItem () As LSAWebPageItem
Function GetDefaultItem () As LSAWebPageItem
Function GetFirstItem () As LSAWebPageItem
Function GetItemByKey (ItemKey As String, MoveCurrentItem As Integer) As LSAWebPageItem
Function GetNextItem () As LSAWebPageItem
Function GetPreviousItem () As LSAWebPageItem
Function getWebPageData () As String
Function hasChanged () As Integer
Function IsDefault (CompareItem As LSAWebPageItem) As Integer
Sub New ()
Function saveToPredefinedFields (doc As NotesDocument) As Integer
Sub SetCurrentItem (NewCurrentItem As LSAWebPageItem)
Sub SetDefaultItem (NewDefaultItem As LSAWebPageItem)
Sub UpdateCurrentItem (UpdateItem As LSAWebPageItem)

Property Detail

Public Property Get DefaultWebPage AsString

Returns the formatted attribute of the default LSAWebPageItem of the named list.

History:
27.JUL.2000RGRreturn empty string if list is empty
Summmary Top

Public Property Get WebPageList AsVariant

Returns an array of serial data strings. Each entry corresponds to a web page in the NamedList and can be used to explode the list.

Summmary Top

Public Property Get WebPageKeyS AsVariant

Returns an array of string with the keys of the web pages maintained in the list

Summmary Top

Public Property Get WebPageS AsVariant

Returns an array of string filled with the the formatted attribute of the WebPageItems maintained by the list

Summmary Top

Public Property Get WebPageDefaultS AsVariant

Returns an array of strings. On the position of the DefaultItem of the list the value is "x"

History:
23.NOV.2000RGRCurrentItemKey Pointer not moved correctly
Summmary Top

Public Property Get Count AsInteger

Returns the number of elements in the web page list

Summmary Top

Public Property Set ListDelimiter AsString

When the object is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ListDelimiter AsString

Summmary Top

Public Property Set ItemDelimiter AsString

When the an item is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ItemDelimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to be use in the items

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top
Method Detail

New

Public Sub New
Initialzes the internal NamedLists.

Summmary Top

Delete

Public Sub Delete
Default destructor of the class. Deletes all child objects

History:
08.JUN.2000RGRDelete the children
Summmary Top

AddItem

Public Sub AddItem(NewItem As LSAWebPageItem)
Adds a new LSAWebPageItem to the list

Parameters:
newItemLSAWebPageItemthe item which is inserted in the list
Summmary Top

ClearCurrentItem

Public Sub ClearCurrentItem
Deletes the current item from the list

Summmary Top

ClearAllItems

Public Sub ClearAllItems
Reinitializes the web page list

Summmary Top

UpdateCurrentItem

Public Sub UpdateCurrentItem(UpdateItem As LSAWebPageItem)
Updates the current item with the data from the UpdateItem

Parameters:
updateItemLSAWebPageItemitem storing the update information
Summmary Top

IsDefault

Public Function IsDefault(CompareItem As LSAWebPageItem) As Integer
Checks if the parameter item is the default item of the list.

Returns:
Booleantrue, if the item is the default item
Summmary Top

SetCurrentItem

Public Sub SetCurrentItem(NewCurrentItem As LSAWebPageItem)
Set the current item to the parameter item

Summmary Top

SetDefaultItem

Public Sub SetDefaultItem(NewDefaultItem As LSAWebPageItem)
Set the default item to the parameter item

Summmary Top

GetItemByKey

Public Function GetItemByKey(ItemKey As String,MoveCurrentItem As Integer) As LSAWebPageItem
Summmary Top

GetDefaultItem

Public Function GetDefaultItem As LSAWebPageItem
Returns the default item of the list.

Returns:
LSAWebPageItemthe default item
Summmary Top

GetCurrentItem

Public Function GetCurrentItem As LSAWebPageItem
Returns the current item of the list

Returns:
LSAWebPageItemitem which the current pointer is pointing at
Summmary Top

GetFirstItem

Public Function GetFirstItem As LSAWebPageItem
Returns the first item of the list

Returns:
LSAWebPageItemthe first item in the list
Summmary Top

GetNextItem

Public Function GetNextItem As LSAWebPageItem
Returns the item next to the current item of the list.

Returns:
LSAWebPageItemnext item to the current item
Summmary Top

GetPreviousItem

Public Function GetPreviousItem As LSAWebPageItem
Summmary Top

saveToPredefinedFields

Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Stores attribute values for the convinience of the programmer. The fields of documents relate to the subform LSASubWebPage from LSL-Address The attribute are only stored if they differ from the values on disk.

Parameters:
docNotesDocumentthe document in which the attributes are stored
Returns:
Booleantrue, if an item of the document has been changed
Summmary Top

Explode

Public Sub Explode(SerialDataArr As Variant)
Fills the list with the serialized object provided by the parameter array The array should be of th form [~~~Homepage~www.acme.com~www.acme.com, ~~x~Sales Info~www.acme.com/sales~www.acme.com/sales] The list also reinitialized this means hasChanged delivers false.

Parameters:
SerialdataArrVariantarray of serial data strings each entry representing an item
Summmary Top

hasChanged

Public Function hasChanged As Integer
Checks if the list has been modified since creation or the last call of the explode method.

Summmary Top

getWebPageData

Public Function getWebPageData As String
Interface for the class LSAAddressData. Calculates a string of the type ##LotusW# as used in the default data string of an unit

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:40:00 AM